| PRPA_MT101106CA Find Associated IDs Response |
Derived from RMIM: PRPA_RM101106CA and HMD: PRPA_HD101106CA |
||||||||
| IdentifiedEntity |
Design Comments: The IdentifiedEntity class is the entry point to the R-MIM and contains one or more identifiers (for example an "internal" id used only by computer systems and an "external" id for display to users) for the Person in the Client Registry. The statusCode is set to "active". The beginning of the effectiveTime is when the record was added to the registry. Rationale: Provides the message entry point required to add a person to the Client Registry |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:IDENT, fixed value= "IDENT"} |
Design Comments: A code specifying the major category of a Role as defined by HL7 vocabulary. UsageNotes: http://www.hl7.org/v3ballot/html/infrastructure/vocabulary/RoleClass.htm Rationale: Provides a means to identify Roles played by entities |
||||||||
| id [1..1000] Role (SET<II.PUBLIC>) |
Design Comments: This identification attribute supports capture of a healthcare identifier specific to the client. This identifier may be assigned jurisdictionally or by care facility. UsageNotes: At least 1 client identifier must be present in the message Rationale: Mandatory attribute supports unique identification of the client. |
||||||||
| statusCode [1..1] Role (CS) {CNE:V:RoleStatus} |
Design Comments: Indicates the status of the Client role (e.g. Active) Rationale: Populated attribute supports the identification of the client |
||||||||
| effectiveTime [0..1] Role (IVL<TS.FULLDATE>) |
Design Comments: An interval of time specifying the period during which this record in a client registry is in effect, if such time limit is applicable and known Rationale: Required attribute supports the identification of the client |
||||||||
| confidentialityCode [1..1] Role (CV) {CNE:V:x_VeryBasicConfidentialityKind} |
Design Comments: A code that controls the disclosure of information about this patient encounter. UsageNotes: Data in the EHR may at some point (and in some jurisdictions) be accessed directly by patients. Some health information may be deemed inappropriate for direct access by patients and requires interpretation by a clinician (e.g. prescription of placebos, analysis of certain psychiatric conditions, etc) Even where direct access by patient is not provided, there may need to be guidance to other providers viewing the record where care should be used in disclosing information to the patient. Non-clinical data (e.g. demographics) may need to be flagged as not for disclosure to patient and or next of kin. There may be professional policy and or legislative guidelines about when/if records may be flagged as not for direct disclosure. Rationale: Populated attribute supports the business requirement to provide restricted access where required |
||||||||
| identifiedPerson [1..1] (Person) |
Design Comments: The Person class contains identifying and demographic data elements for the focal person similar to those in the HL7 v2.x PID segment such as name, gender, date of birth, deceased indicator and time. Rationale: Provides additional demographic data elements for the focal class IdentifiedEntity |
||||||||
| subjectOf [0..1] (Subject) |
Design Comments: Associates the IDENT role with a required observation which indicates the confidence value of the returned record(s). |
||||||||
| Person |
Design Comments: The Person class contains identifying and demographic data elements for the focal person similar to those in the HL7 v2.x PID segment such as name, gender, date of birth, deceased indicator and time. Rationale: Provides additional demographic data elements for the focal class IdentifiedEntity |
||||||||
| classCode [1..1] (M) Person (CS) {CNE:C:EntityClass:PSN, fixed value= "PSN"} |
Design Comments: An HL7 defined value representing the class or category that the Entity instance represents. Examples: Person, Animal, Chemical Substance, Group, Organization UsageNotes: http://www.hl7.org/v3ballot/html/infrastructure/vocabulary/EntityClass.htm Rationale: Due to the extremely large number of potential values for a code set representing all physical things in the universe, the class code indicates both the subtype branch of the Entity hierarchy used as well as a high level classifier to represent the instance of Entity. This can be used to constrain the eligible value domains for the Entity.code attribute. |
||||||||
| determinerCode [1..1] (M) Person (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
Design Comments: An HL7 defined value representing whether the Entity represents a kind-of or a specific instance. Examples: 1 human being (an instance), 3 syringes (quantified kind) or the population of Indianapolis (kind of group) UsageNotes: http://www.hl7.org/v3ballot/html/infrastructure/vocabulary/EntityDeterminer.htm Rationale: An Entity may at times represent information concerning a specific instance (the most common), a quantifiable group with common characteristics or a general type of Entity. This code distinguishes these different representations. |
||||||||
| asOtherIDs [0..100] (OtherIDs) |
Design Comments: Identifiers used for the focal person by other organizations are sent in the OtherIDs class. The other organization can be sent in the E_Organization Entity Class Rationale: Provides the ability to capture additional client identifiers that are not healthcare specific |
||||||||
| OtherIDs |
Design Comments: Identifiers used for the focal person by other organizations are sent in the OtherIDs class. The other organization can be sent in the E_Organization Entity Class Rationale: Provides the ability to capture additional client identifiers that are not healthcare specific |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:IDENT, fixed value= "IDENT"} |
Design Comments: A code specifying the major category of a Role as defined by HL7 vocabulary. Rationale: Provides a means to identify Roles played by entities |
||||||||
| id [1..1] (M) Role (II.PUBLIC) |
Design Comments: Other non-healthcare identifiers for the Client (e.g. Drivers License, RCMP, DND, Social Insurance Number) Rationale: Mandatory attribute supports the identification of the client |
||||||||
| code [1..1] Role (CV) {CNE:D:OtherIdentifiersRoleType} |
Design Comments: A pan Canadian code further specifying the kind of Role such as Drivers License, RCMP, DND, Social Insurance Number Rationale: Populated attribute supports the identification of the client |
||||||||
| assigningIdOrganization [0..1] (IdOrganization) |
Design Comments: The Organization responsible for issuing the Other ID identified in the OtherIDs Role Class Rationale: Supports the requirement to supply additional information regarding the assigning Organization of the OtherID |
||||||||
| IdOrganization |
Design Comments: The Organization responsible for issuing the Other ID identified in the OtherIDs Role Class Rationale: Supports the requirement to supply additional information regarding the assigning Organization of the OtherID |
||||||||
| classCode [1..1] (M) Organization (CS) {CNE:C:EntityClass:ORG, fixed value= "ORG"} |
Design Comments: An HL7 defined value representing the class or category that the Entity instance represents. Examples: Person, Animal, Chemical Substance, Group, Organization UsageNotes: http://www.hl7.org/v3ballot/html/infrastructure/vocabulary/EntityClass.htm Rationale: Due to the extremely large number of potential values for a code set representing all physical things in the universe, the class code indicates both the subtype branch of the Entity hierarchy used as well as a high level classifier to represent the instance of Entity. This can be used to constrain the eligible value domains for the Entity.code attribute. |
||||||||
| determinerCode [1..1] (M) Organization (CS) {CNE:C:EntityDeterminer:INSTANCE, fixed value= "INSTANCE"} |
Design Comments: An HL7 defined value representing whether the Entity represents a kind-of or a specific instance. Examples: 1 human being (an instance), 3 syringes (quantified kind) or the population of Indianapolis (kind of group) UsageNotes: http://www.hl7.org/v3ballot/html/infrastructure/vocabulary/EntityDeterminer.htm Rationale: An Entity may at times represent information concerning a specific instance (the most common), a quantifiable group with common characteristics or a general type of Entity. This code distinguishes these different representations. |
||||||||
| id [1..1] (M) Organization (II.BUS) |
Design Comments: Unique identifier for the organization that assigned the non-healthcare identifier for the client. Rationale: Mandatory attribute supports the identification of the organization assigning the identifier to the client |
||||||||
| name [0..1] Organization (ST) |
Design Comments: A name for the non-healthcare organization Rationale: Populated attribute supports the identification of the organization assigning the identifier to the client |
||||||||
| Subject |
Design Comments: Associates the IDENT role with a required observation which indicates the confidence value of the returned record(s). |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| observationEvent [1..1] (ObservationEvent) |
Design Comments: Each returned IdentifiedPerson can have an associated ObservationEvent reporting the confidence value (degree of certainty) and the name of the matching algorithm that resulted in that record's inclusion in the result set. Rationale: Supports the business requirement to provide a confidence value associated with the identifiedEntity returned in the responsedistinguishes these different representations. |
||||||||
| ObservationEvent |
Design Comments: Each returned IdentifiedPerson can have an associated ObservationEvent reporting the confidence value (degree of certainty) and the name of the matching algorithm that resulted in that record's inclusion in the result set. Rationale: Supports the business requirement to provide a confidence value associated with the identifiedEntity returned in the responsedistinguishes these different representations. |
||||||||
| classCode [1..1] (M) Observation (CS) {CNE:C:ActClass:OBS, fixed value= "OBS"} |
|||||||||
| moodCode [1..1] (M) Observation (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| code [1..1] (M) Observation (CV) {CNE:D:ObservationQueryMatchType} |
Design Comments: Supports the business requirement to identify type of confidence matching used i.e. the code would be the name for the algorithm for the confidence value Rationale: Mandatory attribute supports confident identification of intended client |
||||||||
| value [0..1] Observation (REAL.CONF) |
Design Comments: A real number value indicating the confidence of the query with regard to finding the intended target client i.e. the value would be the computed confidence value. Rationale: Required attribute to provide information about success of query |
||||||||